home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / Xi / XSetDeviceButtonMapping.z / XSetDeviceButtonMapping
Encoding:
Text File  |  1998-10-30  |  6.2 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXSSSSeeeettttDDDDeeeevvvviiiicccceeeeBBBBuuuuttttttttoooonnnnMMMMaaaappppppppiiiinnnngggg((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))XXXXSSSSeeeettttDDDDeeeevvvviiiicccceeeeBBBBuuuuttttttttoooonnnnMMMMaaaappppppppiiiinnnngggg((((3333XXXX11111111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XSetDeviceButtonMapping, XGetDeviceButtonMapping - query or
  10.           change device button mappings
  11.  
  12.      SSSSYYYYNNNNTTTTAAAAXXXX
  13.           int XSetDeviceButtonMapping(_d_i_s_p_l_a_y, _d_e_v_i_c_e, _m_a_p, _n_m_a_p)
  14.                 Display *_d_i_s_p_l_a_y;
  15.                 XDevice *_d_e_v_i_c_e;
  16.                 unsigned char _m_a_p[];
  17.                 int _n_m_a_p;
  18.  
  19.           int XGetDeviceButtonMapping(_d_i_s_p_l_a_y, _d_e_v_i_c_e, _m_a_p__r_e_t_u_r_n,
  20.           _n_m_a_p)
  21.                 Display *_d_i_s_p_l_a_y;
  22.                 XDevice *_d_e_v_i_c_e;
  23.                 unsigned char _m_a_p__r_e_t_u_r_n[];
  24.                 int _n_m_a_p;
  25.  
  26.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  27.           _d_i_s_p_l_a_y     Specifies the connection to the X server.
  28.  
  29.           _d_e_v_i_c_e      Specifies the device whose button mapping is to
  30.                       be queried or changed.
  31.  
  32.           _m_a_p         Specifies the mapping list.
  33.  
  34.           _m_a_p__r_e_t_u_r_n  Returns the mapping list.
  35.  
  36.           _n_m_a_p        Specifies the number of items in the mapping
  37.                       list.
  38.  
  39.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  40.           The _X_S_e_t_D_e_v_i_c_e_B_u_t_t_o_n_M_a_p_p_i_n_g request sets the mapping of the
  41.           specified device.  If it succeeds, the X server generates a
  42.           _D_e_v_i_c_e_M_a_p_p_i_n_g_N_o_t_i_f_y event, and _X_S_e_t_D_e_v_i_c_e_B_u_t_t_o_n_M_a_p_p_i_n_g
  43.           returns _M_a_p_p_i_n_g_S_u_c_c_e_s_s.  Element map[i] defines the logical
  44.           button number for the physical button i+1.  The length of
  45.           the list must be the same as _X_G_e_t_D_e_v_i_c_e_B_u_t_t_o_n_M_a_p_p_i_n_g would
  46.           return, or a _B_a_d_V_a_l_u_e error results.  A zero element
  47.           disables a button, and elements are not restricted in value
  48.           by the number of physical buttons.  However, no two elements
  49.           can have the same nonzero value, or a _B_a_d_V_a_l_u_e error
  50.           results.  If any of the buttons to be altered are logically
  51.           in the down state, _X_S_e_t_D_e_v_i_c_e_B_u_t_t_o_n_M_a_p_p_i_n_g returns
  52.           _M_a_p_p_i_n_g_B_u_s_y, and the mapping is not changed.
  53.  
  54.           _X_S_e_t_D_e_v_i_c_e_B_u_t_t_o_n_M_a_p_p_i_n_g can generate _B_a_d_D_e_v_i_c_e, _B_a_d_M_a_t_c_h,
  55.           and  _B_a_d_V_a_l_u_e errors.
  56.  
  57.           The _X_G_e_t_D_e_v_i_c_e_B_u_t_t_o_n_M_a_p_p_i_n_g request returns the current
  58.           mapping of the specified device.  Buttons are numbered
  59.           starting from one.  _X_G_e_t_D_e_v_i_c_e_B_u_t_t_o_n_M_a_p_p_i_n_g returns the
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXSSSSeeeettttDDDDeeeevvvviiiicccceeeeBBBBuuuuttttttttoooonnnnMMMMaaaappppppppiiiinnnngggg((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))XXXXSSSSeeeettttDDDDeeeevvvviiiicccceeeeBBBBuuuuttttttttoooonnnnMMMMaaaappppppppiiiinnnngggg((((3333XXXX11111111))))
  71.  
  72.  
  73.  
  74.           number of physical buttons actually on the device.  The
  75.           nominal mapping for a device is map[i]=i+1.  The nmap
  76.           argument specifies the length of the array where the device
  77.           mapping is returned, and only the first nmap elements are
  78.           returned in map_return.
  79.  
  80.           _X_G_e_t_D_e_v_i_c_e_B_u_t_t_o_n_M_a_p_p_i_n_g can generate _B_a_d_D_e_v_i_c_e or _B_a_d_M_a_t_c_h
  81.           errors.
  82.  
  83.      DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  84.           _B_a_d_D_e_v_i_c_e   An invalid device was specified.  The specified
  85.                       device does not exist or has not been opened by
  86.                       this client via _X_O_p_e_n_I_n_p_u_t_D_e_v_i_c_e.  This error
  87.                       may also occur if the specified device is the X
  88.                       keyboard or X pointer device.
  89.  
  90.           _B_a_d_M_a_t_c_h    This error may occur if an
  91.                       _X_G_e_t_D_e_v_i_c_e_B_u_t_t_o_n_M_a_p_p_i_n_g or
  92.                       _X_S_e_t_D_e_v_i_c_e_B_u_t_t_o_n_M_a_p_p_i_n_g request was made
  93.                       specifying a device that has no buttons.
  94.  
  95.           _B_a_d_V_a_l_u_e    Some numeric value falls outside the range of
  96.                       values accepted by the request.  Unless a
  97.                       specific range is specified for an argument, the
  98.                       full range defined by the argument's type is
  99.                       accepted.  Any argument defined as a set of
  100.                       alternatives can generate this error.
  101.  
  102.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  103.           XChangeDeviceKeyboardControl(3X),
  104.           XChangeDeviceKeyMapping(3X)
  105.           XChangeDeviceModifierMapping(3X)
  106.           _P_r_o_g_r_a_m_m_i_n_g _W_i_t_h _X_l_i_b
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.